Instance Methods

Set cipher key for a database.
For an encrypted database, you must call it before all other operation.
The cipher page size defaults to 4096 in WCDB, but it defaults to 1024 in other databases. So for an existing database created by other database framework, you should set it to 1024. Otherwise, you’d better to use cipher page size with 4096 or simply call setCipherKey: interface to get better performance.

Set config for this database.

Since WCDB is a multi-handle database, an executing handle will not apply this config immediately.
Instead, all handles will run this config before its next operation.

database.setConfig(named: "demo", with: { (handle: Handle) throws in
    try handle.exec(StatementPragma().pragma(.secureDelete, to: true))
}, orderBy: 1)

This interface is equivalent to database.setConfig(named: name, with: callback, orederBy: Int.max).

Set Synchronous for this database. It will disable checkpoint opti to avoid performance degradation.
Synchronous can improve the stability of the database and reduce database damage, but there will be performance degradation.

You can register a tracer to monitor the performance of all SQLs in this database.
The database tracer will recover the global tracer for specifiy database.

This interface is equivalent to database.setTokenizes(tokenizes)

Setup multiple tokenizers with names for current database.

Generation a Transaction object to do a transaction.

Prepare a specific sql.
Note that you can use this interface to prepare a SQL that is not contained in the WCDB interface layer

Exec a specific sql.
Note that you can use this interface to execute a SQL that is not contained in the WCDB interface layer.

Check whether table exists

Get a wrapper from an existing table.

This interface is equivalent begin(.immediate)

Separate interface of run(transaction:)
You should call begin, commit, rollback and all other operations in same thread.
To do a cross-thread transaction, use getTransaction.

Separate interface of run(transaction:)
You should call begin, commit, rollback and all other operations in same thread. To do a cross-thread transaction, use getTransaction.

Separate interface of run(transaction:) You should call begin, commit, rollback and all other operations in same thread.
To do a cross-thread transaction, use getTransaction.

Run a transaction in closure

try database.run(transaction: { () throws -> Void in 
    try database.insert(objects: objects, intoTable: table)
})

Run a controlable transaction in closure

try database.run(controlableTransaction: { () throws -> Bool in 
    try database.insert(objects: objects, intoTable: table)
    return true // return true to commit transaction and return false to rollback transaction.
})

Run a embedded transaction in closure
The embedded transaction means that it will run a transaction if it’s not in other transaction, otherwise it will be executed within the existing transaction.

try database.run(embeddedTransaction: { () throws -> Void in 
    try database.insert(objects: objects, intoTable: table)
})

Remove all database-related files.
You should call it on a closed database. Otherwise you will get a warning.

This interface is equivalent moveFiles(toDirectory:withExtraFiles:)

Move all database-related files and some extra files to directory safely.
You should call it on a closed database. Otherwise you will get a warning and you may get a corrupted database.

Get the space used by the database files.
You should call it on a closed database. Otherwise you will get a warning.

Backup metadata to recover.
Since metadata will be changed while a table or an index is created or dropped, you should call this periodically.

Recover data from a corruped db. You’d better to recover a closed database.